docs: import os in the opening usage example - #612
Merged
nicoddemus merged 1 commit intoSep 23, 2026
Merged
Conversation
Member
|
Thanks |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
2 participants
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
The opening usage example calls
mocker.patch.object(os, "listdir", autospec=True)without importingos, so copying it into a test module raisesNameError.Add the import to make the example runnable as shown.
Validation: extracted the original and corrected snippets into temporary test modules and ran them with pytest and this checkout's
mockerfixture. The original fails withNameError: name 'os' is not defined; the corrected example passes. The strict Sphinx HTML build also passes.